DigiOffice Gateway Web Services

<back to all web services

ProcessProjectRequestMessage

Requires Authentication
ProcessProjectRequestMessage Parameters:
NameParameterData TypeRequiredDescription
InstanceIdqueryGuidNo
ProjectRequestqueryProjectRequestMessageNo
ProjectRequestMessage Parameters:
NameParameterData TypeRequiredDescription
HeaderformHeaderNo
ProjectReferenceformReferenceNo
IncludeHousingTypesformboolNo
IncludeConstructionBlocksformboolNo
IncludeConstructionNumbersformboolNo
IncludeDocumentsformboolNo
IncludePurchaseContractsformboolNo
Header Parameters:
NameParameterData TypeRequiredDescription
MessageIDformstringNo
TimestampformDateTimeNo
SenderformPartyNo
RecipientformPartyNo
RequestMessageIDformObjectNo
Party Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
CodeformstringNo
VersionformstringNo
EnvironmentformEnvironmentNo
Environment Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
CodeformstringNo
Reference Parameters:
NameParameterData TypeRequiredDescription
GlobalIDformstringNo
TitleformstringNo
ProjectResponseMessage Parameters:
NameParameterData TypeRequiredDescription
HeaderformHeaderNo
ProjectReferenceformReferenceNo
ProjectformProjectNo
HousingTypesformHousingType[]No
ConstructionBlocksformConstructionBlock[]No
ConstructionNumbersformConstructionNumber[]No
DocumentsformDocument[]No
PurchaseContractsformPurchaseContract[]No
Project Parameters:
NameParameterData TypeRequiredDescription
GlobalIDformstringNo
CreationDateformDateTime?No
CreatedByformstringNo
ModifiedDateformDateTime?No
ModifiedByformstringNo
CodeformstringNo
NameformstringNo
Description1formstringNo
Description2formstringNo
AddressformAddressNo
MailingAddressformMailingAddressNo
ProjectCategoryReferenceformReferenceNo
ProjectTypeReferenceformReferenceNo
ProjectStatusReferenceformReferenceNo
StartDateformDateTime?No
EndDateformDateTime?No
CompletionDateformDateTime?No
InactiveformboolNo
WebsiteformstringNo
IsTemplateProjectformboolNo
CustomFieldsformCustomField[]No
Address Parameters:
NameParameterData TypeRequiredDescription
AddressLine1formstringNo
AddressLine2formstringNo
HouseNumberformstringNo
HouseNumberSuffixformstringNo
PostalCodeformstringNo
CityformstringNo
CountryformReferenceNo
MailingAddress Parameters:
NameParameterData TypeRequiredDescription
POBoxformstringNo
PostalCodeformstringNo
CityformstringNo
CountryformReferenceNo
CustomField Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
HousingType Parameters:
NameParameterData TypeRequiredDescription
GlobalIDformstringNo
ProjectReferenceformReferenceNo
CodeformstringNo
DescriptionformstringNo
CustomFieldsformCustomField[]No
CreationDateformDateTime?No
CreatedByformstringNo
ModifiedDateformDateTime?No
ModifiedByformstringNo
ConstructionBlock Parameters:
NameParameterData TypeRequiredDescription
GlobalIDformstringNo
ProjectReferenceformReferenceNo
CodeformstringNo
DescriptionformstringNo
CustomFieldsformCustomField[]No
CreationDateformDateTime?No
CreatedByformstringNo
ModifiedDateformDateTime?No
ModifiedByformstringNo
ConstructionNumber Parameters:
NameParameterData TypeRequiredDescription
GlobalIDformstringNo
ProjectReferenceformReferenceNo
HousingTypeReferenceformReferenceNo
ConstructionBlockReferenceformReferenceNo
CodeformstringNo
DescriptionformstringNo
AddressformAddressNo
RentalHouseformboolNo
GuaranteeCertificateNumberformstringNo
InactiveformboolNo
CustomFieldsformCustomField[]No
CreationDateformDateTime?No
CreatedByformstringNo
ModifiedDateformDateTime?No
ModifiedByformstringNo
ViewingDateformDateTime?No
ViewingDateSpecifiedformboolNo
DeliveryDateformDateTime?No
DeliveryDateSpecifiedformboolNo
Document Parameters:
NameParameterData TypeRequiredDescription
IDformGuidNo
RootDocumentIDformGuidNo
RegistrationprofileIDformGuidNo
TitleformstringNo
FullTitleformstringNo
NumberformstringNo
VersionformstringNo
ExternalNumberformstringNo
ExternalVersionformstringNo
InternalNumberformstringNo
InternalInvoiceNumberformstringNo
PersonIDformintNo
RelationIDformintNo
RelationTitleformstringNo
ProjectIDformintNo
ProjectTitleformstringNo
ExtensionformstringNo
DateformDateTime?No
CommentsCountformintNo
HasCommentsformboolNo
HasPreviewformboolNo
ExtraFieldformstringNo
IsFavoriteformboolNo
DocumentcategoryTextformstringNo
FileSizeformlong?No
FileDateformDateTime?No
HashformstringNo
HashTypeformstringNo
FileUrlformstringNo
StandardDocumentUrlformstringNo
IsCorporateIdentityformboolNo
UserTitleformstringNo
IsFrozenformboolNo
InternalCompanyIDformintNo
DirectUrlformstringNo
AllowDigitalSigningOnlyOnPrimaryVersionsformboolNo
IsPrimaryVersionformboolNo
FileExtensionformstringNo
CustomPropertiesformDictionary<string, Object>No
PurchaseContract Parameters:
NameParameterData TypeRequiredDescription
GlobalIDformstringNo
CodeformstringNo
DescriptionformstringNo
ProjectReferenceformReferenceNo
ProductCodeformstringNo
RelationformRelationNo
InactiveformboolNo
CustomFieldsformCustomField[]No
CreationDateformDateTime?No
CreatedByformstringNo
ModifiedDateformDateTime?No
ModifiedByformstringNo
Relation Parameters:
NameParameterData TypeRequiredDescription
GlobalIDformstringNo
NameLine1formstringNo
NameLine2formstringNo
AddressformAddressNo
MailingAddressformMailingAddressNo
TelephoneformstringNo
MobileformstringNo
EmailformstringNo
IBANformstringNo
BankAccountNumberformstringNo
WebsiteformstringNo
InactiveformboolNo
CustomFieldsformCustomField[]No
CreationDateformDateTime?No
CreatedByformstringNo
ModifiedDateformDateTime?No
ModifiedByformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/ProcessProjectRequestMessage HTTP/1.1 
Host: kpm_digiofficeapigateway.tbi.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"InstanceId":"00000000-0000-0000-0000-000000000000","ProjectRequest":{"Header":{"MessageID":"String","Timestamp":"0001-01-01T00:00:00.0000000","Sender":{"Title":"String","Code":"String","Version":"String","Environment":{"Title":"String","Code":"String"}},"Recipient":{"Title":"String","Code":"String","Version":"String","Environment":{"Title":"String","Code":"String"}},"RequestMessageID":{}},"ProjectReference":{"GlobalID":"String","Title":"String"},"IncludeHousingTypes":false,"IncludeConstructionBlocks":false,"IncludeConstructionNumbers":false,"IncludeDocuments":false,"IncludePurchaseContracts":false}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Header":{"MessageID":"String","Timestamp":"0001-01-01T00:00:00.0000000","Sender":{"Title":"String","Code":"String","Version":"String","Environment":{"Title":"String","Code":"String"}},"Recipient":{"Title":"String","Code":"String","Version":"String","Environment":{"Title":"String","Code":"String"}},"RequestMessageID":{}},"ProjectReference":{"GlobalID":"String","Title":"String"},"Project":{"GlobalID":"String","CreationDate":"0001-01-01T00:00:00.0000000","CreatedBy":"String","ModifiedDate":"0001-01-01T00:00:00.0000000","ModifiedBy":"String","Code":"String","Name":"String","Description1":"String","Description2":"String","Address":{"AddressLine1":"String","AddressLine2":"String","HouseNumber":"String","HouseNumberSuffix":"String","PostalCode":"String","City":"String","Country":{"GlobalID":"String","Title":"String"}},"MailingAddress":{"POBox":"String","PostalCode":"String","City":"String","Country":{"GlobalID":"String","Title":"String"}},"ProjectCategoryReference":{"GlobalID":"String","Title":"String"},"ProjectTypeReference":{"GlobalID":"String","Title":"String"},"ProjectStatusReference":{"GlobalID":"String","Title":"String"},"StartDate":"0001-01-01T00:00:00.0000000","EndDate":"0001-01-01T00:00:00.0000000","CompletionDate":"0001-01-01T00:00:00.0000000","Inactive":false,"Website":"String","IsTemplateProject":false,"CustomFields":[{"Name":"String","Value":"String"}]},"HousingTypes":[{"GlobalID":"String","ProjectReference":{"GlobalID":"String","Title":"String"},"Code":"String","Description":"String","CustomFields":[{"Name":"String","Value":"String"}],"CreationDate":"0001-01-01T00:00:00.0000000","CreatedBy":"String","ModifiedDate":"0001-01-01T00:00:00.0000000","ModifiedBy":"String"}],"ConstructionBlocks":[{"GlobalID":"String","ProjectReference":{"GlobalID":"String","Title":"String"},"Code":"String","Description":"String","CustomFields":[{"Name":"String","Value":"String"}],"CreationDate":"0001-01-01T00:00:00.0000000","CreatedBy":"String","ModifiedDate":"0001-01-01T00:00:00.0000000","ModifiedBy":"String"}],"ConstructionNumbers":[{"GlobalID":"String","ProjectReference":{"GlobalID":"String","Title":"String"},"HousingTypeReference":{"GlobalID":"String","Title":"String"},"ConstructionBlockReference":{"GlobalID":"String","Title":"String"},"Code":"String","Description":"String","Address":{"AddressLine1":"String","AddressLine2":"String","HouseNumber":"String","HouseNumberSuffix":"String","PostalCode":"String","City":"String","Country":{"GlobalID":"String","Title":"String"}},"RentalHouse":false,"GuaranteeCertificateNumber":"String","Inactive":false,"CustomFields":[{"Name":"String","Value":"String"}],"CreationDate":"0001-01-01T00:00:00.0000000","CreatedBy":"String","ModifiedDate":"0001-01-01T00:00:00.0000000","ModifiedBy":"String","ViewingDate":"0001-01-01T00:00:00.0000000","ViewingDateSpecified":false,"DeliveryDate":"0001-01-01T00:00:00.0000000","DeliveryDateSpecified":false}],"Documents":[{"GlobalID":"String","RootDocumentID":"String","Code":"String","Subject":"String","VersionNumber":"String","NewestVersion":false,"RelationReference":{"GlobalID":"String","Title":"String"},"DocumentTypeReference":{"GlobalID":"String","Title":"String"},"ProjectReference":{"GlobalID":"String","Title":"String"},"ConstructionBlockReference":{"GlobalID":"String","Title":"String"},"ConstructionNumberReference":{"GlobalID":"String","Title":"String"},"HousingTypeReference":{"GlobalID":"String","Title":"String"},"Floor":0,"FloorSpecified":false,"DeletedDate":"0001-01-01T00:00:00.0000000","DeletedDateSpecified":false,"File":{"Type":"String","Name":"String","Size":0,"Content":"String","ModifiedDate":"0001-01-01T00:00:00.0000000"},"CustomFields":[{"Name":"String","Value":"String"}],"CreationDate":"0001-01-01T00:00:00.0000000","CreatedBy":"String","ModifiedDate":"0001-01-01T00:00:00.0000000","ModifiedBy":"String"}],"PurchaseContracts":[{"GlobalID":"String","Code":"String","Description":"String","ProjectReference":{"GlobalID":"String","Title":"String"},"ProductCode":"String","Relation":{"GlobalID":"String","NameLine1":"String","NameLine2":"String","Address":{"AddressLine1":"String","AddressLine2":"String","HouseNumber":"String","HouseNumberSuffix":"String","PostalCode":"String","City":"String","Country":{"GlobalID":"String","Title":"String"}},"MailingAddress":{"POBox":"String","PostalCode":"String","City":"String","Country":{"GlobalID":"String","Title":"String"}},"Telephone":"String","Mobile":"String","Email":"String","IBAN":"String","BankAccountNumber":"String","Website":"String","Inactive":false,"CustomFields":[{"Name":"String","Value":"String"}],"CreationDate":"0001-01-01T00:00:00.0000000","CreatedBy":"String","ModifiedDate":"0001-01-01T00:00:00.0000000","ModifiedBy":"String"},"Inactive":false,"CustomFields":[{"Name":"String","Value":"String"}],"CreationDate":"0001-01-01T00:00:00.0000000","CreatedBy":"String","ModifiedDate":"0001-01-01T00:00:00.0000000","ModifiedBy":"String"}]}